/**
 * @file
 *  This file is part of UTILS
 *
 * @author Sebastian Rettenberger <sebastian.rettenberger@tum.de>
 *
 * @copyright Copyright (c) 2013-2015, Technische Universitaet Muenchen.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *  3. Neither the name of the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef UTILS_TIMEUTILS_H_
#define UTILS_TIMEUTILS_H_

#include <ctime>
#include <string>

/**
 * A collection of useful utility functions
 */
namespace utils
{

/**
 * A collection of usefull time functions
 */
class TimeUtils
{
public:
	/**
	 * Formats a string using strftime
	 *
	 * Taken from http://stackoverflow.com/questions/7935483/c-function-to-format-time-t-as-stdstring-buffer-length
	 *
	 * @return A copy of formatString, with all %k replaced with the time information
	 */
	static std::string timeAsString(const std::string& formatString, time_t time)
	{
		const struct tm *timeinfo = localtime(&time);

		std::string buffer;
		buffer.resize(formatString.size()*2);
		size_t len = strftime(&buffer[0], buffer.size(), formatString.c_str(), timeinfo);
		while (len == 0) {
			buffer.resize(buffer.size()*2);
			len = strftime(&buffer[0], buffer.size(), formatString.c_str(), timeinfo);
		}
		buffer.resize(len);
		return buffer;
	}

	/**
	 * @copydoc timeAsString(const std::string&, time_t)
	 *
	 * Returns the formated time for the current time
	 */
	static std::string timeAsString(const std::string& formatString)
	{
		return timeAsString(formatString, time(0L));
	}
};

}

#endif /* UTILS_TIMEUTILS_H_ */
